Accessible Properties
When writing custom JavaScript within your form in addition to referencing forms, pages and Elements, you can also reference a number of individual Elements' Properties.
The following list describes the Properties you can reference within your JavaScript, by Element:
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
| Address Line 1 | addressline1 | string | Value of Address Line 1 text box |
| Address Line 2 | addressline2 | string | Value of Address Line 2 text box |
| Address Line 3 | addressline3 | string | Value of Address Line 3 text box |
| Town/City | townCity | string | Value of Town/City text box |
| County | county | string | Value of County text box |
| Postcode | postcode | string | Value of Postcode text box |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
| Value | value | string | A list (separated by your specified 'separator') containing the values selected in the Check List. The selected items are represented by the items' data values rather than their descriptions. |
| List Items | items | object |
JavaScript object containing the options to be displayed in the Check List. Contains a child object, called columns, with the format:
{label: "<string containing display text>", value:<option's value>, isNew:<flag indicating new option>} For example, options could be added to a Check List using code such as: form1.page1.ndlchecklist1.items.columns. push({label: "Test", value: 10, isNew: false}) |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
| Value | value | string | Value of Checkbox Element |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
| Value | value | base64 encoded image | Base64 encoded version of the ink drawing |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
| Value | value | string or date | Value of the Date Picker. If the Date property contains a value which was entered manually at development time or is input mapped to a Datasource, the value will be a string representation of a date. If populated by custom JavaScript the property can contain either a date object or a string value. |
| Max Date | maxDate | string or date | The maximum allowed date of the Date Picker. This is not enforced for dates that are set by custom JavaScript. If the Max Date property contains a value which was entered manually at development time or is input mapped to a Datasource, the value will be a string representation of a date. If populated by custom JavaScript the property can contain either a date object or a string value. |
| Min Date | minDate | string or date | The minimum allowed date of the Date Picker. This is not enforced for dates that are set by custom JavaScript. If the Min Date property contains a value which was entered manually at development time or is input mapped to a Datasource, the value will be a string representation of a date. If populated by custom JavaScript the property can contain either a date object or a string value. |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
| Value | value | string | Selected value in the Drop List. The selected item is represented by the item's data value rather than its description |
| List Items | items | object |
JavaScript object containing the options to be displayed in the Drop List.
Contains a child object, called columns, with the format: {label:"<string containing display text>", value:<option's value>, isNew:<flag indicating new option>} Examples: Obtain a list of all the display items: var cols = form1.page1.ndldroplist1. options.columns; Access an individual property, such as the label property, within a drop-list item: var displayLabel = form1.page1. ndldroplist1.options. columns[<n>].label; where <n> is the position index of the drop-list item within the array. The first item has an index of 0 (zero). Add options to a Drop List: form1.page1.ndldroplist1.options. columns.push({label: "Test", value: 10, isNew: false}) |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
| Value | value | string | Text value of the Email Text Box |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
| Text | text | string | Text of the Download button's label |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
| Value | value | file object | Value of the File Upload Element |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
| Data Source | imagedata | base64 encoded image | Base64 encoded version of the image, if the Element is input mapped from a database |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
| Value | value | base64 encoded image | Base64 encoded version of the ink drawing |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
| Text | text | string | Value of the Label Element |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
| Text | text | string | Element's display text |
| URL | url | string | Address of the web page to call when link is clicked or tapped at runtime |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
| Text | text | string | Text of the Paragraph Element |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
| Value | value | string | Primary Value of the progress bar. If the Value property contains a value which was entered manually at development time or is input mapped to a Datasource, the value will be a string representation of an integer. If populated by custom JavaScript, the property can contain either an integer or string value. |
| Secondary Value | secondaryProgress | string | Secondary Value of the progress bar. Used in conjunction with the Primary Value to help visualise a dependency between two separate actions or processes (see the Progress Bar Element topic for more information). When the first action or process completes as indicated by the Primary Value, the progress of the second action or process can be monitored using the Secondary Value. If the Secondary Value property contains a value which was entered manually at development time or is input mapped to a Datasource, the value will be a string representation of an integer. If populated by custom JavaScript, the property can contain either an integer or string value. |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
| Value | value | string | Selected value of the Radio List. The selected item is represented by the item's data value rather than its description |
| List Items | items | object |
JavaScript object containing the options to be displayed in the Radio List.
Contains a child object, called columns, with the format: {label:"<string containing display text>", value:<option's value>, isNew:<flag indicating new option>} Options can be added to a Radio List using code such as: form1.page1.ndlradiolist1.options. columns.push({label: "Test", value: 10, isNew: false}) |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
| Event Data | data | object |
JavaScript object containing the event data to be displayed/included in the Schedule.
Contains a child object called columns, with the format: {subject:"<string containing schedule item title>", description:"<string containing the schedule item description>", location:"<string containing schedule location description>", startTime:<start time value, displayed in time format>, endTime:<end time value, displayed in time format>, isAllDay:<flag indicating whether the schedule item is an all day item or not>, isBlock:<flag indicating whether the schedule item is a block item or not>, recurrenceRule:<rule value>, recurrenceException:<rule exception>} |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
| Value | value | string | Primary Value of the slider. For a Slider Type of Min Range (see the Slider Element topic for more information), this will be the higher figure in the specified range, or, in the case of a Slider Type of Range, this will be the lower figure in the specified range. |
| Secondary Value | secondaryValue | string | Secondary Value of the progress bar. Used to determine the secondary figure which will be the higher figure within a specified Range if Slider Type of Range has been selected (see the Slider Element topic for more information). |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
| Value | value | string | Text value of the Text Box |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
| Value | value | string | Text value of the Text Panel |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
| Text | text | string | Value of the Title Text |
| Subtext | subtext | string | Value of the Title Subtext |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
| Transaction Result | transaction | object | Object that stores the transaction state as returned by the Capita Pay360 web service |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
| Map Type | map.type |
map = object
type = string |
String containing the type of map being displayed (as chosen in the 'Map Type' property) - Read-Only |
| Latitude | centre.latitude |
centre = object
latitude = string |
String containing the latitude that the map should be centred around when it is first loaded (as chosen in the 'Latitude' property) - Read-Only |
| Longitude | centre.longitude |
centre = object
longitude = string |
String containing the longitude that the map should be centred around when it is first loaded (as chosen in the 'Longitude' property) - Read-Only |
| Zoom | map.zoom |
map = object
zoom = integer |
String containing the zoom level of the map (as chosen in the 'Zoom' property) - Read-Only |
| Route Start | route.start |
route = object
start = string |
String containing the name of the starting location for the displayed route (as chosen in the 'Route Start' property) - Read-Only |
| Route Finish | route.finish |
route = object
finish = string |
String containing the name of the ending location for the displayed route (as chosen in the 'Route Finish' property) - Read-Only |
| Route Type | route.type |
route = object
type = string |
String containing the type of route being displayed (as chosen in the 'Route Type' property) - Read-Only |
| Pin Latitude | pin.latitude |
pin = object
latitude = string |
String containing the latitude of the most recently dropped pin (populated when the user drops a pin) - Read-Only |
| Pin Longitude | pin.longitude |
pin = object
longitude = string |
String containing the longitude of the most recently dropped pin (populated when the user drops a pin) - Read-Only |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
| Map Type | map.type |
map = object
type = string |
String containing the type of map being displayed (as chosen in the 'Map Type' property) - Read-Only |
| Centre Latitude | centre.latitude |
centre = object
latitude = string |
String containing the latitude that the map should be centred around when it is first loaded (as chosen in the 'Latitude' property) - Read-Only |
| Centre Longitude | centre.longitude |
centre = object
longitude = string |
String containing the longitude that the map should be centred around when it is first loaded (as chosen in the 'Longitude' property) - Read-Only |
| Zoom | map.zoom |
map = object
zoom = integer |
String containing the zoom level of the map (as chosen in the 'Zoom' property) - Read-Only |
| Route Start | route.start |
route = object
start = string |
String containing the name of the starting location for the displayed route (as chosen in the 'Route Start' property) - Read-Only |
| Route Stop | route.finish |
route = object
finish = string |
String containing the name of the ending location for the displayed route (as chosen in the 'Route Finish' property) - Read-Only |
| Route Type | route.type |
route = object
type = string |
String containing the type of route being displayed (as chosen in the 'Route Type' property) - Read-Only |
| Pin Latitude | pin.latitude |
pin = object
latitude = string |
String containing the latitude of the most recently dropped pin (populated when the user drops a pin) - Read-Only |
| Pin Longitude | pin.longitude |
pin = object
longitude = string |
String containing the longitude of the most recently dropped pin (populated when the user drops a pin) - Read-Only |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
| Bing Map Type | bing.mapStyle |
bing = object
type = string |
String containing the type of Bing map being displayed (as chosen in the 'Bing Map Type' property) - Read-Only |
| Centre Latitude | centre.latitude |
centre = object
latitude = string |
String containing the latitude that the map should be centred around when it is first loaded (as chosen in the 'Latitude' property) - Read-Only |
| Centre Longitude | centre.longitude |
centre = object
longitude = string |
String containing the longitude that the map should be centred around when it is first loaded (as chosen in the 'Longitude' property) - Read-Only |
| Provider | map.provider |
map = object
provider = string |
String containing the provider of the map (as chosen in the 'Provider' property) - Read-Only |
| Zoom | map.zoom |
map = object
zoom = integer |
String containing the zoom level of the map (as chosen in the 'Zoom' property) - Read-Only |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
|
Name of Property in Properties Pane |
Name to use to Reference Property within Code |
Data Type |
Description |
|---|---|---|---|
| n/a | htmlId | string | Element's HTML ID |
| Value | value | object |
JavaScript object containing the options to be displayed in the Recordset.
Contains a child object, called columns, whose format will depend on the columns being displayed in the Recordset. |